<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="models library API docs, for the Dart programming language.">
  <title>models library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">yuuna</a></li>
    <li class="self-crumb">models library</li>
  </ol>
  <div class="self-name">models</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
    
      <div>
<h1><span class="kind-library">models</span> library 
 
</h1></div>

    


    <section class="summary offset-anchor" id="classes">
      <h2>Classes</h2>

      <dl>
        <dt id="AppModel">
  <span class="name "><a href="../models/AppModel-class.html">AppModel</a></span> 

</dt>
<dd>
  A scoped model for parameters that affect the entire application.
RiverPod is used for global state management across multiple layers,
especially for preferences that persist across application restarts.
</dd>

        <dt id="CreatorModel">
  <span class="name "><a href="../models/CreatorModel-class.html">CreatorModel</a></span> 

</dt>
<dd>
  A scoped model for parameters that affect the card creator. RiverPod is
used for global state management across multiple layers, and is useful for
showing the creator and sharing code across the entire application.
</dd>

      </dl>
    </section>




    <section class="summary offset-anchor" id="properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="appProvider" class="property">
  <span class="name"><a href="../models/appProvider.html">appProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/flutter_riverpod/1.0.4/flutter_riverpod/ChangeNotifierProvider-class.html">ChangeNotifierProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../models/AppModel-class.html">AppModel</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for app-wide configuration and state management.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="creatorProvider" class="property">
  <span class="name"><a href="../models/creatorProvider.html">creatorProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/flutter_riverpod/1.0.4/flutter_riverpod/ChangeNotifierProvider-class.html">ChangeNotifierProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../models/CreatorModel-class.html">CreatorModel</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for the card creator.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="fieldsByKey" class="property">
  <span class="name"><a href="../models/fieldsByKey.html">fieldsByKey</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter"><a href="../creator/Field-class.html">Field</a></span>&gt;</span></span> 

</dt>
<dd>
  A list of media types that the app will support at runtime.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="globalFields" class="property">
  <span class="name"><a href="../models/globalFields.html">globalFields</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../creator/Field-class.html">Field</a></span>&gt;</span></span> 

</dt>
<dd>
  A list of fields that the app will support at runtime.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="globalSchemas" class="property">
  <span class="name"><a href="../models/globalSchemas.html">globalSchemas</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://pub.dev/documentation/isar/3.1.0+1/isar/CollectionSchema-class.html">CollectionSchema</a></span>&gt;</span></span> 

</dt>
<dd>
  Schemas used in Isar database.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="instantExportProvider" class="property">
  <span class="name"><a href="../models/instantExportProvider.html">instantExportProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/flutter_riverpod/1.0.4/flutter_riverpod/ChangeNotifierProvider-class.html">ChangeNotifierProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../models/CreatorModel-class.html">CreatorModel</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for separately handling instant export.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="pipSearchPositionProvider" class="property">
  <span class="name"><a href="../models/pipSearchPositionProvider.html">pipSearchPositionProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/StateProvider-class.html">StateProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for listening to search term position changes in PIP mode.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="pipSearchResultProvider" class="property">
  <span class="name"><a href="../models/pipSearchResultProvider.html">pipSearchResultProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/FutureProvider-class.html">FutureProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../dictionary/DictionarySearchResult-class.html">DictionarySearchResult</a>?</span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for listening to search results in PIP mode.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="pipSearchTermProvider" class="property">
  <span class="name"><a href="../models/pipSearchTermProvider.html">pipSearchTermProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/StateProvider-class.html">StateProvider</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for listening to search term changes in PIP mode.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="quickActionColorProvider" class="property">
  <span class="name"><a href="../models/quickActionColorProvider.html">quickActionColorProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/FutureProviderFamily-class.html">FutureProviderFamily</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-ui/Color-class.html">Color</a>?</span>&gt;</span></span>, <span class="type-parameter"><a href="../dictionary/DictionaryHeading-class.html">DictionaryHeading</a></span>&gt;</span></span> 

</dt>
<dd>
  Provides color for all quick actions.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="visibleOnceProvider" class="property">
  <span class="name"><a href="../models/visibleOnceProvider.html">visibleOnceProvider</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/StateProviderFamily-class.html">StateProviderFamily</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>, <span class="type-parameter"><a href="../dictionary/DictionaryHeading-class.html">DictionaryHeading</a></span>&gt;</span></span> 

</dt>
<dd>
  A global <a href="https://pub.dev/documentation/riverpod/1.0.3/riverpod/Provider-class.html">Provider</a> for maintaining visible once state.
  <div class="features"><span class="feature">final</span></div>

</dd>

      </dl>
    </section>





  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">yuuna</a></li>
  <li class="self-crumb">models library</li>
</ol>


    <h5><span class="package-name">yuuna</span> <span class="package-kind">package</span></h5>
    <ol>
      <li class="section-title">Libraries</li>
      <li><a href="../creator/creator-library.html">creator</a></li>
      <li><a href="../dictionary/dictionary-library.html">dictionary</a></li>
      <li><a href="../language/language-library.html">language</a></li>
      <li><a href="../main/main-library.html">main</a></li>
      <li><a href="../media/media-library.html">media</a></li>
      <li><a href="../models/models-library.html">models</a></li>
      <li><a href="../pages/pages-library.html">pages</a></li>
      <li><a href="../i18n_strings.g/i18n_strings.g-library.html">strings.g</a></li>
      <li><a href="../utils/utils-library.html">utils</a></li>
</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <h5>models library</h5>
    <ol>
      <li class="section-title"><a href="../models/models-library.html#classes">Classes</a></li>
        <li><a href="../models/AppModel-class.html">AppModel</a></li>
        <li><a href="../models/CreatorModel-class.html">CreatorModel</a></li>




      <li class="section-title"><a href="../models/models-library.html#properties">Properties</a></li>
        <li><a href="../models/appProvider.html">appProvider</a></li>
        <li><a href="../models/creatorProvider.html">creatorProvider</a></li>
        <li><a href="../models/fieldsByKey.html">fieldsByKey</a></li>
        <li><a href="../models/globalFields.html">globalFields</a></li>
        <li><a href="../models/globalSchemas.html">globalSchemas</a></li>
        <li><a href="../models/instantExportProvider.html">instantExportProvider</a></li>
        <li><a href="../models/pipSearchPositionProvider.html">pipSearchPositionProvider</a></li>
        <li><a href="../models/pipSearchResultProvider.html">pipSearchResultProvider</a></li>
        <li><a href="../models/pipSearchTermProvider.html">pipSearchTermProvider</a></li>
        <li><a href="../models/quickActionColorProvider.html">quickActionColorProvider</a></li>
        <li><a href="../models/visibleOnceProvider.html">visibleOnceProvider</a></li>




</ol>

  </div><!--/sidebar-offcanvas-right-->

</main>

<footer>
  <span class="no-break">
    yuuna
      2.8.0+93
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

